BOT UX API

(0 reviews)

LCPR Fixed Customer Identification

GET

This operation identifies the customer by using accountNumber or phoneNumber by retrieving customer information such as customer-registered email, phonenumber and address.

Use Case 1 (Identification of customer using AccountNumber): API call is getBalanceEnquiry to retrieve email, phonenumber and address.
Use Case 2 (Identification of customer using PhoneNumber/ServiceNumber): API call is getAccounts to retrieve email, phonenumber and address. (note: the response provides email if the size of listAccounts is less than or equal to 3, if the size of listAccounts is greater than 3 the response includes only address and phoneNumber and does not include email.)

1. balanceEnquiry [GET]

URL

http://[host]:[port]/bot-ux/v1/{businessId}/balanceEnquiry

Base URI Parameter

Note: JM, PA, PR and CL is actual Implementation and for other BUs is Stub Implementation

Name	Type	M/O	Description
businessId	string	M	businessId string M Business unit identifier. Example: JM, PA, PR, CL

Headers

name	value	description	required
Correlation-ID	string	This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b	O
lob	String	The Line of Business Identifier currently available are: Enum: PREPAID, POSTPAID,FIXED Note : here it is for Fixed users : FIXED	M
refid	String	The Reference Identifier currently available are: Enum: CUSTOMER_ID, ACCOUNT_NO, SERVICE_NO, RUT_ID TICKETID, RUTID$ACCTID, CONTACT_NO Note : here it is for ACCOUNT_NO	M
refvalue	String	The Reference Value Ex:8211990010013290	M

Security Headers

Name	Type	M/O	Description
client_id	string	M	Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 6f0ed16a7b494d76b2d60e05bc3b3332
client_secret	string	M	Client secret value for Client Id Enforcement policy. Environment Specific Value, eg: e4CD4D43449846aA9D8Cb9c43fAd324a

Possible success response

PR Success Response

{
    "id": "8211990010013290",
    "accountType": "RES",
    "description": "JOHN DOE",
    "lastModified": "2021-04-30T00:00:00.000Z",
    "name": "JOHN DOE",
    "paymentStatus": "Z",
    "state": "Chard Off",
    "accountBalance": [
        {
            "amount": {
                "unit": "USD",
                "value": 277.94
            },
            "balanceType": "ReceivableBalance",
            "validFor": {
                "startDateTime": "2023-06-29T00:00:00.000Z",
                "endDateTime": "2023-07-28T00:00:00.000Z"
            }
        },
        {
            "amount": {
                "unit": "USD",
                "value": 277.94
            },
            "balanceType": "DelinquentBalance",
            "validFor": {
                "startDateTime": "",
                "endDateTime": ""
            }
        },
        {
            "amount": {
                "unit": "USD",
                "value": 0.00
            },
            "balanceType": "LastPaymentAmount",
            "validFor": {
                "startDateTime": "",
                "endDateTime": "0001-01-01T00:00:00.000Z"
            }
        }
    ],
    "accountRelationship": [
        {
            "relationshipType": "contains",
            "account": {
                "id": "8211990010013290",
                "description": "RES JOHN DOE",
                "name": "JOHN DOE",
                "@type": "BillingAccount"
            },
            "validFor": {
                "startDateTime": "2021-04-06T00:00:00.000Z",
                "endDateTime": "2021-04-30T00:00:00.000Z"
            }
        }
    ],
    "billStructure": {
        "cycleSpecification": {
            "name": "monthly Billing",
            "dateShift": 1,
            "frequency": "monthly"
        },
        "presentationMedia": [
            {
                "name": "Email"
            }
        ]
    },
    "contact": [
        {
            "contactName": "JOHN DOE",
            "contactType": "Primary",
            "partyRoleType": "Owner",
            "contactMedium": [
                {
                    "mediumType": "PostalAddress",
                    "preferred": true,
                    "characteristic": {
                        "city": "SAN JUAN",
                        "country": "USA",
                        "postCode": "00917",
                        "street1": "LIBERTY TOWER APT 2020"
                    }
                },
                {
                    "mediumType": "Phone",
                    "characteristic": {
                        "contactType": "Home",
                        "phoneNumber": "7879257003"
                    }
                },
                {
                    "mediumType": "Email",
                    "characteristic": {
                        "emailAddress": "EMAIL@GMAIL.COM"
                    }
                }
            ],
            "relatedParty": {
                "id": "9999",
                "name": "JOHN DOE",
                "role": "Owner",
                "@type": "relatedParty"
            }
        }
    ],
    "creditLimit": {
        "unit": "USD",
        "value": 100.00
    },
    "defaultPaymentMethod": {
        "id": "",
        "name": " "
    },
    "financialAccount": {
        "id": "2063",
        "accountBalance": {
            "balanceType": "ReceivableBalance",
            "amount": {
                "unit": "USD",
                "value": 1
            },
            "validFor": {
                "startDateTime": "2023-06-29T00:00:00.000Z",
                "endDateTime": "2023-07-28T00:00:00.000Z"
            }
        },
        "@referredType": "financialAccount"
    },
    "paymentPlan": [
        {
            "paymentFrequency": "01",
            "totalAmount": {
                "unit": "USD",
                "value": 0.00
            },
            "planType": "Auto Pay Disable"
        }
    ],
    "characteristic": [
        {
            "name": "LocationId",
            "value": "00917000000914"
        },
        {
            "name": "DunningGroup",
            "value": "090"
        },
        {
            "name": "DelinquencyDays",
            "value": "882"
        }
    ],
    "relatedParty": [
        {
            "id": "1101521435631",
            "name": "JOHN DOE",
            "role": "Customer",
            "@referredType": "Customer"
        }
    ],
    "@type": "BillingAccount"
}

Possible error response

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
    "errors": [
        {
            "code": 400,
            "message": "APIKIT:BAD_REQUEST",
            "description": "Invalid value 'OO' for uri parameter businessId. OO is not a valid enum value"
        }
    ]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 403 ]

Forbidden - Indicates that the server understood the request but refuses to fulfill it. If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials.

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method post not allowed for : /{businessId}/balanceEnquiry"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": "error description"
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Not implemented for Operation GET /balanceEnquiry for Business Id: XXXXXX  not implemented"
    }]
  }

[ 503 ]

Service Unavailable

{
    "errors": [
        {
            "code": 503,
            "message": "HTTP:SERVICE_UNAVAILABLE",
            "description": "HTTP POST on resource 'http://0.0.0.0:9092/liberate- customer-sys/v1/JM/billingAccount/' failed: service unavailable (503)."
        }
    ]
}

2. accounts [GET]

URL

http://[host]:[port]/bot-ux/v1/{businessId}/accounts